<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <title>Docs For Class Madoqua_Cache_Action</title>
    <link rel="stylesheet" type="text/css" href="../../media/style.css" />
    <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
  </head>
  <body>
  
    <h1>Madoqua :: Docs For Class Madoqua_Cache_Action</h1>

    <table width="100%">
      <tr valign="top">
        <td class="menu">
                                <div class="package">
              <div id="todolist">
                <p><a href="../../todolist.html">Todo List</a></p>
              </div>
            </div>
                    <h2>Packages:</h2>
          <div class="package">
            <ul>
                              <li>
                  <a href="../../classtrees_default.html">default</a>
                </li>
                              <li>
                  <a href="../../classtrees_Application.html">Application</a>
                </li>
                              <li>
                  <a href="../../classtrees_Cache.html">Cache</a>
                </li>
                              <li>
                  <a href="../../classtrees_Controller.html">Controller</a>
                </li>
                              <li>
                  <a href="../../classtrees_Db.html">Db</a>
                </li>
                              <li>
                  <a href="../../classtrees_Filter.html">Filter</a>
                </li>
                              <li>
                  <a href="../../classtrees_Form.html">Form</a>
                </li>
                              <li>
                  <a href="../../classtrees_Install.html">Install</a>
                </li>
                              <li>
                  <a href="../../classtrees_Loader.html">Loader</a>
                </li>
                              <li>
                  <a href="../../classtrees_Madoqua_Exception.html">Madoqua_Exception</a>
                </li>
                              <li>
                  <a href="../../classtrees_Madoqua_Observer.html">Madoqua_Observer</a>
                </li>
                              <li>
                  <a href="../../classtrees_Madoqua_Plugin.html">Madoqua_Plugin</a>
                </li>
                              <li>
                  <a href="../../classtrees_Madoqua_View.html">Madoqua_View</a>
                </li>
                              <li>
                  <a href="../../classtrees_Module.html">Module</a>
                </li>
                              <li>
                  <a href="../../classtrees_Naneau_Plugin.html">Naneau_Plugin</a>
                </li>
                              <li>
                  <a href="../../classtrees_Redirector.html">Redirector</a>
                </li>
                              <li>
                  <a href="../../classtrees_Search.html">Search</a>
                </li>
                              <li>
                  <a href="../../classtrees_Validate.html">Validate</a>
                </li>
                              <li>
                  <a href="../../classtrees_View.html">View</a>
                </li>
                          </ul>
          </div>
                                                                    <h2>Classes:</h2>
                <ul>
	<li>Action	    <ul>		<li><a href="../../Cache/Action/Madoqua_Cache_Action.html">Madoqua_Cache_Action</a></li>    </ul></li>	  </ul>
  <ul>
		    		<li><a href="../../Cache/Madoqua_Cache_Config.html">Madoqua_Cache_Config</a></li>    	    		<li><a href="../../Cache/Madoqua_Cache_News.html">Madoqua_Cache_News</a></li>    	  </ul>
                              </td>
        <td>
          <table style="width:750px;" cellpadding="10" cellspacing="10px">
            <tr>
              <td valign="top">
                                                                  <h2>Cache::Action::Madoqua_Cache_Action</h2>
                                <div class="menu">
          
                                                                                
                                                                                                                                                                                                                                                                                                                                                                                                [ <a href="../../index.html">Index</a> ]
                      [ <a href="../../classtrees_Cache.html">Cache classes</a> ]
            [ <a href="../../elementindex_Cache.html">Cache elements</a> ]
                    [ <a href="../../elementindex.html">All elements</a> ]
          [ <a href="../../errors.html">Errors</a> ]
                </div>
<a name="sec-description"></a>
<h2>Class Madoqua_Cache_Action</h2>

<p>Madoqua_Cache_Action</p>		










  <a name="sec-var-summary"></a>
  <h2>Member Variables</h2>
  <table class="summary">
                  <tr>
          <td class="right">
            <em>protected</em>            static
            <em>Zend_Cache_Core</em>          </td>
          <td>
            <code>
              $_cache
                          </code>
            <br /><div style="margin-left: 20px">the cache</div>                      </td>
        </tr>
                          </table>


  <a name="sec-method-summary"></a>
  <h2>Method Summary</h2>
  <table class="summary">
                  <tr>
          <td class="right">
            <em>public</em>            static
                        <em>bool</em>          </td>
          <td>
            <code>
              <a href="#canCache"><b>canCache</b></a>(
               )
            </code>
            <br /><div style="margin-left: 20px">does the config allow caching?</div>          </td>
        </tr>
                        <tr>
          <td class="right">
            <em>public</em>            static
                        <em>void</em>          </td>
          <td>
            <code>
              <a href="#clean"><b>clean</b></a>(
                                                                                    $tags
                                                 )
            </code>
            <br /><div style="margin-left: 20px">clean the action cache with a specific set of tags</div>          </td>
        </tr>
                        <tr>
          <td class="right">
            <em>public</em>            static
                        <em>Zend_Cache_Core</em>          </td>
          <td>
            <code>
              <a href="#get"><b>get</b></a>(
               )
            </code>
            <br /><div style="margin-left: 20px">get the action cache</div>          </td>
        </tr>
                        <tr>
          <td class="right">
            <em>public</em>            static
                        <em>string</em>          </td>
          <td>
            <code>
              <a href="#getId"><b>getId</b></a>(
                                                                                    $module
                                                    ,                                     $controller
                                                    ,                                     $action
                                                    ,                   [                  $params
                   = array()]                               )
            </code>
            <br /><div style="margin-left: 20px">get a cache id</div>          </td>
        </tr>
                        <tr>
          <td class="right">
            <em>public</em>            static
                        <em>string</em>          </td>
          <td>
            <code>
              <a href="#getIdRequest"><b>getIdRequest</b></a>(
                                                                                    $request
                                                 )
            </code>
            <br /><div style="margin-left: 20px">get an id for a request object</div>          </td>
        </tr>
                        <tr>
          <td class="right">
            <em>public</em>            static
                        <em>array</em>          </td>
          <td>
            <code>
              <a href="#getTags"><b>getTags</b></a>(
                                                                                    $module
                                                    ,                                     $controller
                                                    ,                                     $action
                                                 )
            </code>
            <br /><div style="margin-left: 20px">get an array of tags</div>          </td>
        </tr>
                        <tr>
          <td class="right">
            <em>public</em>            static
                        <em>string</em>          </td>
          <td>
            <code>
              <a href="#getTagsRequest"><b>getTagsRequest</b></a>(
                                                                                    $request
                                                 )
            </code>
            <br /><div style="margin-left: 20px">Enter description here...</div>          </td>
        </tr>
                        <tr>
          <td class="right">
            <em>public</em>            static
                        <em>bool</em>          </td>
          <td>
            <code>
              <a href="#hasCache"><b>hasCache</b></a>(
                                                                                    $request
                                                 )
            </code>
            <br /><div style="margin-left: 20px">is there a cached version of this request?</div>          </td>
        </tr>
                        <tr>
          <td class="right">
            <em>public</em>            static
                        <em>bool|string</em>          </td>
          <td>
            <code>
              <a href="#loadCache"><b>loadCache</b></a>(
                                                                                    $request
                                                 )
            </code>
            <br /><div style="margin-left: 20px">load cache for a given request</div>          </td>
        </tr>
                        <tr>
          <td class="right">
            <em>public</em>            static
                        <em>bool|string</em>          </td>
          <td>
            <code>
              <a href="#saveCache"><b>saveCache</b></a>(
                                                                                    $result
                                                    ,                                     $request
                                                 )
            </code>
            <br /><div style="margin-left: 20px">save the cache for a request</div>          </td>
        </tr>
                                                                                                                    </table>


  <a name="sec-methods"></a>
  <h2>Methods</h2>
  <a name='method_detail'></a>
      <a name="methodcanCache" id="canCache"><!-- --></a>

    <h3>canCache</h3>

    <div class="method-signature">
      static bool
      canCache(
      )
    </div>

      <p>does the config allow caching?</p>      
      
      
      
      
      
        <a name="methodclean" id="clean"><!-- --></a>

    <h3>clean</h3>

    <div class="method-signature">
      static void
      clean(
                                  array
          $tags
                        )
    </div>

      <p>clean the action cache with a specific set of tags</p>      
              <h4>Parameters:</h4>
        <table class="detail">
          <thead>
            <tr>
              <th>Name</th>
              <th>Type</th>
              <th class="desc">Description</th>
            </tr>
          </thead>
          <tbody>
                          <tr>
                <td><code>$tags</code></td>
                <td><em>array</em></td>
                <td>
                                  </td>
              </tr>
                      </tbody>
        </table>
      
      
      
      
      
        <a name="methodget" id="get"><!-- --></a>

    <h3>get</h3>

    <div class="method-signature">
      static Zend_Cache_Core
      get(
      )
    </div>

      <p>get the action cache</p>      
      
      
      
      
      
        <a name="methodgetId" id="getId"><!-- --></a>

    <h3>getId</h3>

    <div class="method-signature">
      static string
      getId(
                                  string
          $module
                            ,           string
          $controller
                            ,           string
          $action
                            ,           [array
          $params
           = array()]              )
    </div>

      <p>get a cache id</p>      
              <h4>Parameters:</h4>
        <table class="detail">
          <thead>
            <tr>
              <th>Name</th>
              <th>Type</th>
              <th class="desc">Description</th>
            </tr>
          </thead>
          <tbody>
                          <tr>
                <td><code>$module</code></td>
                <td><em>string</em></td>
                <td>
                                  </td>
              </tr>
                          <tr>
                <td><code>$controller</code></td>
                <td><em>string</em></td>
                <td>
                                  </td>
              </tr>
                          <tr>
                <td><code>$action</code></td>
                <td><em>string</em></td>
                <td>
                                  </td>
              </tr>
                          <tr>
                <td><code>$params</code></td>
                <td><em>array</em></td>
                <td>
                                  </td>
              </tr>
                      </tbody>
        </table>
      
      
      
      
      
        <a name="methodgetIdRequest" id="getIdRequest"><!-- --></a>

    <h3>getIdRequest</h3>

    <div class="method-signature">
      static string
      getIdRequest(
                                  Zend_Controller_Request_Abstract|string
          $request
                        )
    </div>

      <p>get an id for a request object</p><div><p>will return string if string given</p></div>      
              <h4>Parameters:</h4>
        <table class="detail">
          <thead>
            <tr>
              <th>Name</th>
              <th>Type</th>
              <th class="desc">Description</th>
            </tr>
          </thead>
          <tbody>
                          <tr>
                <td><code>$request</code></td>
                <td><em>Zend_Controller_Request_Abstract|string</em></td>
                <td>
                                  </td>
              </tr>
                      </tbody>
        </table>
      
      
      
      
      
        <a name="methodgetTags" id="getTags"><!-- --></a>

    <h3>getTags</h3>

    <div class="method-signature">
      static array
      getTags(
                                  string
          $module
                            ,           string
          $controller
                            ,           string
          $action
                        )
    </div>

      <p>get an array of tags</p>      
              <h4>Parameters:</h4>
        <table class="detail">
          <thead>
            <tr>
              <th>Name</th>
              <th>Type</th>
              <th class="desc">Description</th>
            </tr>
          </thead>
          <tbody>
                          <tr>
                <td><code>$module</code></td>
                <td><em>string</em></td>
                <td>
                                  </td>
              </tr>
                          <tr>
                <td><code>$controller</code></td>
                <td><em>string</em></td>
                <td>
                                  </td>
              </tr>
                          <tr>
                <td><code>$action</code></td>
                <td><em>string</em></td>
                <td>
                                  </td>
              </tr>
                      </tbody>
        </table>
      
      
      
      
      
        <a name="methodgetTagsRequest" id="getTagsRequest"><!-- --></a>

    <h3>getTagsRequest</h3>

    <div class="method-signature">
      static string
      getTagsRequest(
                                  Zend_Controller_Request_Abstract|string
          $request
                        )
    </div>

      <p>Enter description here...</p>      
              <h4>Parameters:</h4>
        <table class="detail">
          <thead>
            <tr>
              <th>Name</th>
              <th>Type</th>
              <th class="desc">Description</th>
            </tr>
          </thead>
          <tbody>
                          <tr>
                <td><code>$request</code></td>
                <td><em>Zend_Controller_Request_Abstract|string</em></td>
                <td>
                                  </td>
              </tr>
                      </tbody>
        </table>
      
      
      
      
      
        <a name="methodhasCache" id="hasCache"><!-- --></a>

    <h3>hasCache</h3>

    <div class="method-signature">
      static bool
      hasCache(
                                  Zend_Controller_Request_Abstract|string
          $request
                        )
    </div>

      <p>is there a cached version of this request?</p>      
              <h4>Parameters:</h4>
        <table class="detail">
          <thead>
            <tr>
              <th>Name</th>
              <th>Type</th>
              <th class="desc">Description</th>
            </tr>
          </thead>
          <tbody>
                          <tr>
                <td><code>$request</code></td>
                <td><em>Zend_Controller_Request_Abstract|string</em></td>
                <td>
                                  </td>
              </tr>
                      </tbody>
        </table>
      
      
      
      
      
        <a name="methodloadCache" id="loadCache"><!-- --></a>

    <h3>loadCache</h3>

    <div class="method-signature">
      static bool|string
      loadCache(
                                  Zend_Controller_Request_Abstract|string
          $request
                        )
    </div>

      <p>load cache for a given request</p>      
              <h4>Parameters:</h4>
        <table class="detail">
          <thead>
            <tr>
              <th>Name</th>
              <th>Type</th>
              <th class="desc">Description</th>
            </tr>
          </thead>
          <tbody>
                          <tr>
                <td><code>$request</code></td>
                <td><em>Zend_Controller_Request_Abstract|string</em></td>
                <td>
                                  </td>
              </tr>
                      </tbody>
        </table>
      
      
      
      
      
        <a name="methodsaveCache" id="saveCache"><!-- --></a>

    <h3>saveCache</h3>

    <div class="method-signature">
      static bool|string
      saveCache(
                                  
          $result
                            ,           Zend_Controller_Request_Abstract|string
          $request
                        )
    </div>

      <p>save the cache for a request</p>      
              <h4>Parameters:</h4>
        <table class="detail">
          <thead>
            <tr>
              <th>Name</th>
              <th>Type</th>
              <th class="desc">Description</th>
            </tr>
          </thead>
          <tbody>
                          <tr>
                <td><code>$request</code></td>
                <td><em>Zend_Controller_Request_Abstract|string</em></td>
                <td>
                                  </td>
              </tr>
                          <tr>
                <td><code>$result</code></td>
                <td><em></em></td>
                <td>
                                  </td>
              </tr>
                      </tbody>
        </table>
      
      
      
      
      
  
                    
<p class="notes">
  Located in <a class="field" href="_Cache---Action.php.html">/Cache/Action.php</a> 
  [<span class="field">line 20</span>]
</p>

                <div class="credit">
                  Documentation generated on Fri, 16 Jan 2009 10:14:36 +0100 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.2</a>
                </div>
              </td>
            </tr>
          </table>
        </td>
      </tr>
    </table>
  </body>
</html>